API — Storefront — public

Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.

---

GET /api/storefront/branding

Get Storefront Branding

Exemplo resposta (200):

{
  "name": "string",
  "template_id": null,
  "branding_primary_color": null,
  "branding_secondary_color": null,
  "branding_accent_color": null,
  "branding_logo_url": null,
  "branding_banner_url": null,
  "branding_hero_url": null,
  "branding_favicon_url": null,
  "branding_tagline": null,
  "branding_about_text": null,
  "branding_cta_text": null,
  "branding_show_categories": true,
  "branding_show_featured": true,
  "branding_social_instagram": null,
  "branding_social_facebook": null,
  "branding_social_whatsapp": null,
  "branding_social_tiktok": null,
  "seo_title": null,
  "seo_description": null,
  "phone": null,
  "email": null,
  "address": null,
  "city": null,
  "default_currency": "string",
  "default_language": "string"
}

---

GET /api/storefront/products

List Storefront Products

Parametros:

Nome	Tipo	Obrigatorio	Descricao
page	integer	Nao	—
page_size	integer	Nao	—
search	string	Nao	—
category_slug	string	Nao	—
min_price	string	Nao	—
max_price	string	Nao	—
in_stock	string	Nao	—
featured	string	Nao	—
sort_by	string	Nao	Sort: newest

Exemplo resposta (200):

{
  "items": [
    "..."
  ],
  "total": 0,
  "page": 0,
  "page_size": 0,
  "total_pages": 0
}

Erros possiveis: 422 Validation Error

---

GET /api/storefront/products/{slug}

Get Storefront Product

Parametros:

Nome	Tipo	Obrigatorio	Descricao
slug	string	Sim	—

Exemplo resposta (200):

{
  "id": 0,
  "tenant_id": 0,
  "sku": null,
  "name": "string",
  "slug": "string",
  "description": null,
  "short_description": null,
  "price": "string",
  "sale_price": null,
  "sale_start": null,
  "sale_end": null,
  "cost_price": null,
  "weight": null,
  "stock_quantity": 0,
  "stock_status": "string",
  "manage_stock": true,
  "is_active": true,
  "is_featured": true,
  "product_type": "string",
  "brand": null,
  "tax_class": "string",
  "display_order": 0,
  "views_count": 0,
  "sales_count": 0,
  "avg_rating": "string",
  "meta_title": null,
  "meta_description": null,
  "created_at": null,
  "updated_at": null,
  "images": [
    "..."
  ],
  "variants": [
    "..."
  ],
  "categories": [
    "..."
  ],
  "tags": [
    "..."
  ]
}

Erros possiveis: 422 Validation Error

---

GET /api/storefront/categories

List Storefront Categories

Exemplo resposta (200):

[{
  "id": 0,
  "slug": "string",
  "name": "string",
  "description": null,
  "image_url": null,
  "parent_id": null,
  "product_count": 0,
  "is_active": true,
  "position": 0
}]

---

GET /api/storefront/categories/{slug}

Get Storefront Category

Parametros:

Nome	Tipo	Obrigatorio	Descricao
slug	string	Sim	—

Exemplo resposta (200):

{
  "id": 0,
  "slug": "string",
  "name": "string",
  "description": null,
  "image_url": null,
  "parent_id": null,
  "product_count": 0,
  "is_active": true,
  "position": 0
}

Erros possiveis: 422 Validation Error

---

POST /api/storefront/newsletter

Subscribe Newsletter

Corpo do pedido:

Campo	Tipo	Obrigatorio	Descricao
email	string	Sim	Email

Exemplo pedido:

{
  "email": "string"
}

Exemplo resposta (200):

{
  "success": true,
  "message": "string"
}

Erros possiveis: 422 Validation Error

---

Documentacao gerada automaticamente.